Skip to content

⚠️ CONFLICT! Lineage pull request for: skeleton - #148

Merged
jsf9k merged 57 commits into
developfrom
lineage/skeleton
May 20, 2025
Merged

⚠️ CONFLICT! Lineage pull request for: skeleton#148
jsf9k merged 57 commits into
developfrom
lineage/skeleton

Conversation

@cisagovbot

@cisagovbot cisagovbot commented Mar 28, 2025

Copy link
Copy Markdown

Lineage Pull Request: CONFLICT

Achtung!!!

Lineage has created this pull request to incorporate new changes found in an
upstream repository:

Upstream repository: https://github.com/cisagov/skeleton-generic.git
Remote branch: HEAD

Check the changes in this pull request to ensure they won't cause issues with
your project.

The lineage/skeleton branch has one or more unresolved merge conflicts
that you must resolve before merging this pull request!

How to resolve the conflicts

  1. Take ownership of this pull request by removing any other assignees.

  2. Clone the repository locally, and reapply the merge:

    git clone git@github.com:cisagov/skeleton-python-library.git skeleton-python-library
    cd skeleton-python-library
    git remote add skeleton https://github.com/cisagov/skeleton-generic.git
    git remote set-url --push skeleton no_push
    git switch develop
    git switch --create lineage/skeleton --track origin/develop
    git pull skeleton HEAD
    git status
  3. Review the changes displayed by the status command. Fix any conflicts and
    possibly incorrect auto-merges.

  4. After resolving each of the conflicts, add your changes to the
    branch, commit, and push your changes:

    git add .github/dependabot.yml .github/labels.yml .github/workflows/build.yml .github/workflows/codeql-analysis.yml requirements-dev.txt 
    git commit
    git push --force --set-upstream origin lineage/skeleton

    Note that you may append to the default merge commit message
    that git creates for you, but please do not delete the existing
    content
    . It provides useful information about the merge that is
    being performed.

  5. Wait for all the automated tests to pass.

  6. Confirm each item in the "Pre-approval checklist" below.

  7. Remove any of the checklist items that do not apply.

  8. Ensure every remaining checkbox has been checked.

  9. Mark this draft pull request "Ready for review".

✅ Pre-approval checklist

  • ✌️ The conflicts in this pull request have been resolved.
  • All future TODOs are captured in issues, which are referenced in code comments.
  • All relevant type-of-change labels have been added.
  • All new and existing tests pass.

Note

You are seeing this because one of this repository's maintainers has
configured Lineage to open pull requests.

For more information:

🛠 Lineage configurations for this project are stored in .github/lineage.yml

📚 Read more about Lineage

jsf9k and others added 30 commits November 20, 2024 14:40
Use a specific number of spaces instead of the default of only caring
if the number of spaces used is consistent within a file. Ensure that
block sequences inside of mappings are indented.
The use of flow sequences and mappings is not as readable as block
collections and so should be discouraged. Since it is a cleaner
representation for empty collections we will allow those, but if an
application otherwise requires flow collections they can be explicitly
enabled by disabling the checks per
https://yamllint.readthedocs.io/en/stable/disable_with_comments.html
When running ansible-lint it will throw the following warning with our
current configuration:
WARNING  Found incompatible custom yamllint configuration (.yamllint), please either remove the file or edit it to comply with:
  - comments.min-spaces-from-content must be 1
  - braces.max-spaces-inside must be 1
  - octal-values.forbid-implicit-octal must be true
  - octal-values.forbid-explicit-octal must be true.
Thus we implement these configuration rules.
Previously we disabled the `truthy` rule due to Ansible's use of
`yes`/`no` for boolean values. That is no longer the case and the
default configuration used by ansible-lint now has this rule enabled.
The use of `on` as a key in GitHub Actions workflow syntax means we
needed to add disable-line comments for the truthy rule.
Add a configuration for the `quoted-strings` rule that matches our best
practices. Other files are updated to comply with these new settings.
Also add semver as a dev requirement.

I'd like to start versioning descendants of skeleton-ansible-role (in
anticipation of pinning Ansible role versions at a future date), and I
thought it would make sense to go ahead and implement this at the
skeleton-generic level to force us to start versioning all
repositories.

Repositories that already version can ignore these changes when they
flow down via Lineage, since they will already have their own version
files and version-bumping script.
This is done automatically with the `pre-commit autoupdate` command.
This new action simply applies our standard permissions monitoring and
runner hardening.  Using it allows us to DRY out the GH Actions
workflows in our skeleton repositories a bit.
Co-authored-by: Nick M <50747025+mcdonnnj@users.noreply.github.com>
GitHubSecurityLab/actions-permissions and step-security/harden-runner
are no longer direct dependencies since we are now using
cisagov/action-job-preamble.

Co-authored-by: Nick M <50747025+mcdonnnj@users.noreply.github.com>
Co-authored-by: Nick M <50747025+mcdonnnj@users.noreply.github.com>
Flesh out the comment a little so its meaning is clearer.

Co-authored-by: Nick M <50747025+mcdonnnj@users.noreply.github.com>
Make sure to mention that the permissions monitoring config can be
changed by creating a repo-level variable; there is no need to modify
the workflow.

Co-authored-by: Nick M <50747025+mcdonnnj@users.noreply.github.com>
…preamble

This action supports this functionality now, so we may as well take
advantage of it.

Also disable GH permissions monitoring, since that functionality is
poorly implemented and has been causing a lot of problems due to the
MITM implementation hogging or leaking memory.
Apply our standard job preamble via cisagov/action-job-preamble
CodeQL now supports GitHub Actions as a language, so it makes sense to
add such a workflow to this repository.

See this link for more details:
https://github.blog/changelog/2024-12-17-find-and-fix-actions-workflows-vulnerabilities-with-codeql-public-preview/
Also correctly sort YAML keys.

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>
This aligns with the changes in cisagov/skeleton-generic#201.

Co-authored-by: Nick M <50747025+mcdonnnj@users.noreply.github.com>
Children of this skeleton repository will require this Dependabot
ignore directive.
Use cisagov/action-job-preamble instead of
crazy-max/ghaction-github-status and crazy-max/ghaction-dump-context
directly.
This action reviews dependency changes for vulnerabilities and license
changes.
This aligns with the changes in cisagov/skeleton-generic#201.

Co-authored-by: Nick M <50747025+mcdonnnj@users.noreply.github.com>
This functionality is poorly implemented and has been causing problems
due to the MITM implementation hogging or leaking memory.
@jsf9k
jsf9k force-pushed the lineage/skeleton branch from 71394ea to ac2813c Compare April 8, 2025 20:13
Comment thread .github/workflows/dependency-review.yml Outdated

@mcdonnnj mcdonnnj left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM after the one change I've requested.

Comment thread .github/dependabot.yml
Co-authored-by: Nick M <50747025+mcdonnnj@users.noreply.github.com>
@jsf9k
jsf9k added this pull request to the merge queue May 19, 2025
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks May 19, 2025
@jsf9k
jsf9k force-pushed the lineage/skeleton branch 9 times, most recently from c2cf999 to 1d81a39 Compare May 20, 2025 14:36
The latter is deprecated and is not included in the most recent
version of types-setuptools.  This leads to an error from the mypy
pre-commit hook.
@jsf9k
jsf9k force-pushed the lineage/skeleton branch from 6b347e3 to a90b940 Compare May 20, 2025 14:56
This is necessary for the secret_message line using importlib to
correctly work with Python 3.9.  See here for more details:
https://setuptools.pypa.io/en/latest/userguide/datafiles.html?utm_source=chatgpt.com#namespace-support

Co-authored-by: felddy <felddy@github.com>
@jsf9k
jsf9k force-pushed the lineage/skeleton branch from a90b940 to 2b8de19 Compare May 20, 2025 14:57
@jsf9k
jsf9k added this pull request to the merge queue May 20, 2025
Merged via the queue into develop with commit eb5f53e May 20, 2025
@jsf9k
jsf9k deleted the lineage/skeleton branch May 20, 2025 15:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file github-actions Pull requests that update GitHub Actions code security This issue or pull request addresses a security issue upstream update This issue or pull request pulls in upstream updates

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants